Skip to main content
POST
/
api
/
call
/
start-calling
curl --location '{{baseUrl}}/api/call/start-calling' \
  --header 'Authorization: Bearer {{authToken}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "batchId": "6806382f98da85ec32fac955",
    "userId": "64e5f12345abcdef12345678"
  }'

{
  "message": "",
  "status": true,
  "code": 200,
  "errorMessage": "",
  "data": {
    "batchId": "6806382f98da85ec32fac955",
    "status": "started"
  }
}

​
Overview

Use this endpoint to kick off automated dialing for a batch once all data checks pass. The call processing runs asynchronously—responses confirm that the batch moved to the queue while individual call events continue to arrive through webhooks and batch polling.

​
Prerequisites

  • Batch already exists and contains the final contact list.
  • The authenticated user has Calling Management permissions.
  • Plivo webhooks are configured if you need real-time updates.

​
Request

​
Authorization
string
required
Bearer token for an approved workspace administrator.
​
batchId
string
required
Identifier of the batch to start dialing.
​
userId
string
required
ID of the user who owns the batch.
​
callingNumbers
array[string]
Phone IDs the dialer should rotate through. Optional if batch already has calling numbers configured.
​
callData
array[object]
Call records to process. Optional if batch already contains calls. If provided, these calls will be processed instead of existing batch calls.
​
uuid
string
Optional UUID for tracking this calling session.
curl --location '{{baseUrl}}/api/call/start-calling' \
  --header 'Authorization: Bearer {{authToken}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "batchId": "6806382f98da85ec32fac955",
    "userId": "64e5f12345abcdef12345678"
  }'

​
Response

{
  "message": "",
  "status": true,
  "code": 200,
  "errorMessage": "",
  "data": {
    "batchId": "6806382f98da85ec32fac955",
    "status": "started"
  }
}
​
status
boolean
required
Indicates whether the batch was successfully queued for dialing.
​
code
integer
required
HTTP status code (200 for success).
​
data
object
Additional information about the started batch.

​
Error Handling

  • 400 Bad Request – Missing required parameters (batchId or userId).
  • 401 Unauthorized – Bearer token missing or expired.
  • 404 Not Found – Batch not found or user not found.
  • 500 Internal Server Error – Failed to start calling service; retry or contact support.
Calling Behavior:
  • If callData is provided, those calls will be processed (useful for immediate calling)
  • If callData is not provided, the system uses existing calls in the batch
  • The calling service runs asynchronously
  • Calls are queued and processed based on batch configuration (calling hours, allowed days, etc.)
  • Monitor progress using GET /api/call/batch-details/{batchId} or webhook callbacks

Authorizations

​
Authorization
string
header
required

Bearer token authentication for workspace access

Body

application/json
​
batchId
string
required
Example:

"6806382f98da85ec32fac955"

​
userId
string
required
Example:

"64e5f12345abcdef12345678"

​
callingNumbers
string[]
Example:
["67d52be3f91fe7017efdb6f1"]
​
callData
object[]
​
uuid
string
Example:

"some-unique-uuid"

Response

Calling service started successfully